Overblik

Dette afsnit beskriver de tilgængelige REST-endpoints til hentning af aktuelle dokumentoplysninger fra tinglysningssystemet.

Dokumenter kan hentes ved hjælp af deres UUID eller alias (dato-løbenummer). Svarformatet kan styres via valgfrie query parametre, der understøtter OIO XML, XHTML, TMV XHTML og JSON formater.

Endpoints

DokumentByUuid

Endpoint URL: dokaktuel/uuid/{uuid}

Method

GET

Beskrivelse

Hent aktuelle dokumentoplysninger ved hjælp af dets UUID. Svarformatet kan styres via valgfrie query parametre.

Input

Path parameter:

  • uuid

Valgfrie query parametre:

  • xhtml=true - returnerer svaret som XHTML

  • xhtml=json - returnerer svaret som JSON

  • tmvXhtml=true - returnerer svaret som TMV XHTML

  • Hvis ingen angives, returneres som OIO XML (standard)

Output

Dokumentdata i det ønskede format (OIO XML, XHTML, TMV XHTML eller JSON).

Formateringen af XHTML- og TMV XHTML-svar er ikke dokumenteret i detaljer og kan ændres uden varsel.

Fejlhåndtering

Standard HTTP fejlkoder ved ugyldigt input eller manglende adgang.

Interaktionsmønster

Forespørgsel-svar

Eksempel på forespørgsel:

GET /dokaktuel/uuid/7b63e538-35c5-47ba-ad07-da4ad567466f?xhtml=false&tmvxhtml=false HTTP/1.1
host: nc-dev-xml-api.tinglysning.dk
accept: */*

DokumentByAlias

Endpoint URL: dokaktuel/alias/{alias}

Method

GET

Beskrivelse

Hent aktuelle dokumentoplysninger ved hjælp af dets alias.

Input

Path parameter:

  • alias

Valgfrie query parametre:

  • xhtml=true - returnerer svaret som XHTML

  • tmvXhtml=true - returnerer svaret som TMV XHTML

  • Hvis ingen angives, returneres som OIO XML (standard)

Output

Dokumentdata i det ønskede format (OIO XML, XHTML eller TMV XHTML).

Formateringen af XHTML- og TMV XHTML-svar er ikke dokumenteret i detaljer og kan ændres uden varsel.

Fejlhåndtering

Standard HTTP fejlkoder ved ugyldigt input eller manglende adgang.

Interaktionsmønster

Forespørgsel-svar

Eksempel på forespørgsel:

GET /dokaktuel/alias/20230228-1000046099?xhtml=false&tmvxhtml=false HTTP/1.1
host: nc-dev-xml-api.tinglysning.dk
accept: */*

FindByAlias

Endpoint URL: dokfind/alias

Method

GET

Beskrivelse

Find et dokument ved hjælp af dets alias (dato-løbenummer format). Returnerer grundlæggende dokumentoplysninger, hvis fundet.

Input

Query parameter:

  • alias

Output

JSON-svar indeholdende grundlæggende dokumentoplysninger, hvis fundet.

Fejlhåndtering

  • Standard HTTP fejlkoder ved ugyldigt input eller manglende adgang

Interaktionsmønster

Forespørgsel-svar

Eksempel på forespørgsel:

GET /dokfind/alias?alias=20230228-1000046099 HTTP/1.1
host: nc-dev-xml-api.tinglysning.dk
accept: */*